Skip to main content
Version: 2.0

Call Permission Message

The WhatsApp Call Permission Request (CPR) Interactive API allows businesses to request explicit user consent before initiating a voice call on WhatsApp. This API sends an interactive call permission message to the user, displaying a short text along with call permission action buttons.

ObjectDescription
typeSet to call_permission_request.
body.textSet to text displayed to the user explaining why call permission is being requested, shown above the call permission action buttons.
action.nameSet to call_permission_request.

Payload:

{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "<PHONE_NUMBER_ID> or <WHATSAPP_ID>",
"type": "interactive",
"interactive": {
"type": "call_permission_request",
"action": {
"name": "call_permission_request"
},
"body": {
"text": "We would like to call you to help support your query on Order No: ON-12853."
}
},
"metadata": {
"messageId": "xxx",
"transactionId": null,
"callbackDlrUrl": "https://xyz.com"
}
}

Note : Callback URL is an optional parameter. Please use when you want to change the default URL(configured through smartta). It will only change the domain name, other parameters will be same as configurated in smartta.
Additionally, messageId is also an optional parameter used for identification of the message and must not exceed 100 characters.